Skip to content

Create CONTRIBUTION.md #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Create CONTRIBUTION.md #16

wants to merge 1 commit into from

Conversation

@Mayur-Pagote
Copy link

@Mayur-Pagote Mayur-Pagote commented Oct 11, 2025 •
edited by coderabbitai bot
Loading

This pull request resolves issue #15.
Kindly review it and label it with the Hacktoberfest tags.

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive contribution guide covering Code of Conduct, how to report bugs and request features, pull request workflow, development setup, commit and PR guidelines, coding style and best practices, and testing expectations.
    • Included licensing notes, contributor etiquette, environment setup instructions, and links to support resources to streamline onboarding and ensure consistent, high-quality contributions.

@coderabbitai
Copy link

coderabbitai bot commented Oct 11, 2025 •
edited
Loading

Walkthrough

Adds a new CONTRIBUTION.md documenting contribution processes, including code of conduct, issue/PR workflow, development setup, commit/PR guidelines, coding style, testing expectations, licensing, and support channels.

Changes

Cohort / File(s) Summary of Changes
Contribution Guidelines
CONTRIBUTION.md		 Added a comprehensive contributor guide covering Code of Conduct, contribution steps (bugs/features/PRs), dev setup, commit/PR rules, coding/style best practices, testing, licensing, and help resources.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I thump my paws—new trails to tread,
A map for helpers, clearly spread.
Forks and branches, tests in bloom,
Commits hop lightly, PRs vroom-vroom.
With carrots packed and docs in sight,
We code by moon and merge by night.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title “Create CONTRIBUTION.md” directly and succinctly reflects the main change of adding a new CONTRIBUTION.md file with contribution guidelines, clearly summarizing the pull request’s purpose.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Comment @coderabbitai help to get the list of available commands and usage tips.

coderabbitai[bot]
coderabbitai bot reviewed Oct 11, 2025
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
CONTRIBUTION.md (1)

114-118: Add a language hint to the commit message code block.

Markdownlint flags this fenced block because no language is specified. Tag it as plain text to silence the warning and aid renderers.

-  ```
+  ```text
   <type>(<scope>): <short description>
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7584a96 and 6c44cca.

📒 Files selected for processing (1)
  • CONTRIBUTION.md (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
CONTRIBUTION.md

22-22: Link fragments should be valid

(MD051, link-fragments)

114-114: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@Mayur-Pagote